Skip to content

docs: Add Observation support to library descriptions#17

Merged
takeshishimada merged 1 commit intomainfrom
docs/add-observation-to-description
Oct 31, 2025
Merged

docs: Add Observation support to library descriptions#17
takeshishimada merged 1 commit intomainfrom
docs/add-observation-to-description

Conversation

@takeshishimada
Copy link
Copy Markdown
Contributor

Summary

  • Update library descriptions to explicitly mention Observation support
  • Clarifies that Flow is built on both Observation and Swift 6 Approachable Concurrency
  • Maintains unidirectional data flow as the primary feature

Changes

  • README.md: Added "Observation and" to the description
  • README_jp.md: Added "Observationと" to the Japanese description
  • Sources/Flow/Flow.docc/Flow.md: Added "Observation and" to DocC documentation

Motivation

The library heavily relies on SwiftUI's @Observable macro and Observation framework, which is a key differentiator from other state management libraries that depend on Combine or @ObservableObject. This update ensures the description accurately reflects this technical foundation.

Test plan

  • Verify README.md displays correctly on GitHub
  • Verify README_jp.md displays correctly on GitHub
  • Verify Flow.md renders correctly in DocC documentation
  • Build and preview DocC documentation locally

🤖 Generated with Claude Code

Update library descriptions to explicitly mention Observation support alongside Swift 6 Approachable Concurrency. This clarifies that Flow is built on both Observation and Swift 6 concurrency features.

Files updated:
- README.md
- README_jp.md
- Sources/Flow/Flow.docc/Flow.md

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions github-actions Bot added documentation Improvements or additions to documentation feature labels Oct 31, 2025
@takeshishimada takeshishimada self-assigned this Oct 31, 2025
@takeshishimada takeshishimada merged commit bf73da3 into main Oct 31, 2025
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant